Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RDoc-2600 Describe RavenDB Cloud Product Features #1895

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

hiddenshadow21
Copy link
Contributor


{PANEL: OLAP ETL }

RavenDB Cloud provides OLAP ETL capabilities, allowing you to integrate your operational data with analytical data
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RavenDB Cloud provides OLAP ETL capabilities, allowing you to integrate your operational data with analytical data
*RavenDB Cloud* provides *OLAP ETL* capabilities, allowing you to integrate your operational data with analytical data


{PANEL: PowerBi }

RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you
*RavenDB Cloud* supports direct integration with *Power BI*, a leading business analytics tool. This feature allows you

{PANEL: PowerBi }

RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you
to seamlessly connect your RavenDB data with Power BI for advanced visualization and reporting, enabling real-time
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to seamlessly connect your RavenDB data with Power BI for advanced visualization and reporting, enabling real-time
to seamlessly connect your *RavenDB* data with *Power BI* for advanced visualization and reporting, enabling real-time

## Configuration

{WARNING: Required }
PowerBi IPs must be configured after enabling PowerBi feature.
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
PowerBi IPs must be configured after enabling PowerBi feature.
*Power BI* IPs must be configured **after** enabling *Power BI* feature.

PowerBi IPs must be configured after enabling PowerBi feature.
{WARNING/}

To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP
To access *Power BI* Configuration View click **Configure** Button in *Power BI* feature row. Here you can edit your IP

{WARNING/}

To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP
addresses that will have access to RavenDB PowerBi port.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
addresses that will have access to RavenDB PowerBi port.
addresses that will have access to *RavenDB Power BI* port.

To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP
addresses that will have access to RavenDB PowerBi port.

!["PowerBi Configuration View"](images/product-features-powerbi-configuration.png "PowerBi Configuration View")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
!["PowerBi Configuration View"](images/product-features-powerbi-configuration.png "PowerBi Configuration View")
!["Power BI Configuration View"](images/product-features-powerbi-configuration.png "Power BI Configuration View")

!["PowerBi Configuration View"](images/product-features-powerbi-configuration.png "PowerBi Configuration View")

{INFO: }
PowerBi IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
PowerBi IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
*Power BI* IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)


{PANEL: Queue ETL }

The Queue ETL feature enables you to export data from RavenDB to various queue systems, such as RabbitMQ or Kafka.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Queue ETL feature enables you to export data from RavenDB to various queue systems, such as RabbitMQ or Kafka.
The *Queue ETL* feature enables you to export data from *RavenDB* to various queue systems, such as *RabbitMQ* or *Kafka*.


{PANEL: Queue Sink }

Queue Sink allows RavenDB Cloud to directly receive data from queues, making it easier to ingest data into your
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Queue Sink allows RavenDB Cloud to directly receive data from queues, making it easier to ingest data into your
*Queue Sink* allows *RavenDB Cloud* to directly receive data from queues, making it easier to ingest data into your

Usage of this feature is described [here](../server/ongoing-tasks/queue-sink/overview).

{INFO: Availability }
This feature is available only for RavenDB 6.0 and newer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This feature is available only for RavenDB 6.0 and newer.
This feature is available only for *RavenDB* **6.0** and newer**.


{PANEL: Data Archival }

RavenDB Cloud offers the ability to archive selected documents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RavenDB Cloud offers the ability to archive selected documents.
*RavenDB Cloud* offers the ability to archive selected documents.

{PANEL: Data Archival }

RavenDB Cloud offers the ability to archive selected documents.
Archived documents are compressed and can be handled differently by RavenDB functions (e.g. Indexing can exclude
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Archived documents are compressed and can be handled differently by RavenDB functions (e.g. Indexing can exclude
Archived documents are compressed and can be handled differently by *RavenDB* functions (e.g. Indexing can exclude

Usage of this feature is described [here](../server/extensions/archival).

{INFO: Availability }
This feature is available only for RavenDB 6.0 and newer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This feature is available only for RavenDB 6.0 and newer.
This feature is available only for *RavenDB* **6.0** and newer**.


{PANEL: Monitoring }

RavenDB Cloud allows you to monitor your RavenDB Cloud instances via SNMP protocol. SNMP is a widely used network
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RavenDB Cloud allows you to monitor your RavenDB Cloud instances via SNMP protocol. SNMP is a widely used network
*RavenDB Cloud* allows you to monitor your *RavenDB Cloud* instances via *SNMP* protocol. *SNMP* is a widely used network


## Configuration

Click **Configure** Button in Monitoring Feature Row in order to configure this feature.
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Click **Configure** Button in Monitoring Feature Row in order to configure this feature.
Click **Configure** Button in *Monitoring* feature row in order to configure this feature.

### SNMP Monitoring IPs

{WARNING: Required }
SNMP Monitoring IPs must be configured after enabling Monitoring feature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SNMP Monitoring IPs must be configured after enabling Monitoring feature.
*SNMP Monitoring* IPs must be configured **after** enabling *Monitoring* feature.

### SNMPv3 Monitoring credentials

SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up
SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
SNMPv3 monitoring for your *RavenDB Cloud* instances, you need to configure specific credentials that ensure secure

SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
communication between the SNMP agent on your end and the RavenDB.

Credentials required to connect to RavenDB Monitoring Endpoints are provided in this section. We also provide sample
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Credentials required to connect to RavenDB Monitoring Endpoints are provided in this section. We also provide sample
Credentials required to connect to *RavenDB Monitoring* Endpoints are provided in this section. We also provide sample

command you can use to test connection.

{INFO: }
SNMP Monitoring IPs entries
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SNMP Monitoring IPs entries
*SNMP Monitoring* IPs entries


SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up
SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
communication between the SNMP agent on your end and the RavenDB.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
communication between the SNMP agent on your end and the RavenDB.
communication between the *SNMP* agent on your end and the *RavenDB*.


### SNMPv3 Monitoring credentials

SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up
*SNMPv3* is the most secure version of *SNMP*, providing enhanced security features over its predecessors. When setting up

### SNMPv3 Monitoring credentials

SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up
SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure
*SNMPv3* monitoring for your *RavenDB Cloud* instances, you need to configure specific credentials that ensure secure

SNMP Monitoring IPs must be configured after enabling Monitoring feature.
{WARNING/}

This section allows you to specify IPs that will have access to your product using SNMP protocol.
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This section allows you to specify IPs that will have access to your product using SNMP protocol.
This section allows you to specify IPs that will have access to your product using the *SNMP* protocol.

Copy link
Contributor

@PFYasu PFYasu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor fixes & a small adjustment regarding the impact of managing the features on a RDB server.

@@ -0,0 +1,117 @@
# Cloud: Product Features
Copy link
Contributor

@PFYasu PFYasu Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a note about the impact of enabling / disabling the features. IIRC in general these actions restart the RavenDB service - we should notify about that by adding a WARNING section in the particular feature descriptions.

@PFYasu
Copy link
Contributor

PFYasu commented Sep 17, 2024

After the latest changes within the documentation, please consider rebasing onto master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants